Спринт 3/18 → Тема 2/3: Финальный проект спринта: модуль фитнес-трекера → Урок 2/5
Как мы проверяем финальные задания
Первый этап: автоматическая проверка линтером
Сразу же после отправки на платформу ваш код будет автоматически проверен на соответствие требованиям по оформлению кода, описанных в PEP8.
Проверка выполняется с использованием модуля flake8. Если ваш код не соответствует PEP8 — в интерфейсе платформы вы получите сообщение об этом. В этом случае вам нужно будет доработать код и снова отправить его на проверку.
Второй этап: проверка автоматическими тестами
После проверки линтером ваше задание проверяется на платформе автоматическими тестами. Эти тесты — те же, которые вы запускали локально на своём компьютере перед отправкой проекта на платформу.
Успешное прохождение тестов не означает, что задание выполнено и решение принято. Более того, успешный результат проверки тестами не гарантирует, что с кодом всё хорошо и что его нельзя сделать лучше.
❗ Задача автоматических тестов — проверить выполнение ключевых пунктов задания и избавить ревьюеров от рутины при дальнейшей проверке.
Воспринимайте тесты как часть техзадания: они подскажут конкретику там, где текстовое описание задачи выглядело недостаточно ясным.
В автотестах мы стараемся достичь двух целей: не дать отклониться от выполнения минимально необходимых требований задания и при этом не ограничивать студента, который написал работающий код не так, как ожидалось при составлении задания.
Если ваша работа не пройдёт автотесты — вы получите сообщение об этом на учебной платформе. В этой ситуации в код нужно внести исправления и вновь отправить код на проверку.
Может получиться так, что локально тесты прошли успешно, а на платформе выдают ошибку. Причиной может быть отличие тестов на вашем компьютере от тестов на платформе (тесты на платформе периодически обновляются; или бывает так, что студент случайно изменяет локальные тесты).
Скачайте актуальные тесты из репозитория Яндекс Практикума: в инструкции описано, как это сделать.
Могут быть и иные причины того, что автоматические тесты на платформе не проходят. Если что-то идёт не так — наставник поможет разобраться с проблемой.
Третий этап: код-ревью, проверка человеком
После того, как автотесты на платформе пройдены — за дело берётся опытный разработчик-ревьюер. Он внимательно прочтёт ваш код и запустит его. Если ревьюер обнаружит ошибки или заметит, что в решении были применены плохие практики — он оставит рекомендации по улучшению кода. В этом случае вам нужно будет доработать код в соответствии с рекомендациями и снова отправить его на проверку.
Ревьюеры могут возвращать ваш код на доработку несколько раз, будьте к этому готовы.
Как смотреть рекомендации ревьюера
Работа отправлена на проверку ревьюеру; проверка будет выполнена не более чем за 24 часа.
После того, как ревьюер проверит вашу работу — вам придёт письмо. Замечания и рекомендации ревьюера можно увидеть на платформе, во вкладке «Ревью».
В интерфейсе появится отметка «Есть замечания» (если её нет — значит, вы прошли ревью с первого раза), закладка «История» и заглавный комментарий ревьюера. Заглавный комментарий — это не основное ревью, а лишь обобщающее мнение ревьюера о вашей работе.
Разверните и прочитайте заглавный комментарий ревьюера:
Основная часть ревью — ниже заглавного комментария. Открывайте папки и файлы, там будут доступны все замечания. Возле названия директорий показано общее количество комментариев, оставленных к коду.
Обратите внимание на количество и значение комментариев: серое — советы, красное — ошибки, зелёное — похвалы.
- Красные замечания — «Надо исправить», они обязательны к исправлению.
- Серые замечания — «Можно лучше», это необязательные рекомендации, однако если есть время — лучше выполнить и их: ревьюеры-разработчики делятся нажитым опытом, не упускайте возможности сделать этот опыт своим.
- Зелёные комментарии — небольшие, но ценные медали; это повод задаться вопросом «кто тут молодец?».
Дальше — работа по исправлению кода: открывайте проект на своём компьютере и вносите правки.
Выполненные требования ревьюера можно отмечать на платформе — для этого есть кнопка «Отметить как выполненный»; после нажатия на неё комментарий свернётся. Эта отметка — только для вас, ревьюер не видит, какие комментарии вы отметили как выполненные.
Итерации ревью
Для каждого проекта может быть проведено несколько ревью: проверили-исправили, проверили-исправили, и так несколько раз. Все итерации ревью хранятся на платформе, в разделе «История».
Этот раздел устроен почти так же, как «Ревью», но в нём нельзя ничего изменить — можно лишь читать замечания и открывать/закрывать итерации, папки и файлы.
Обратите внимание на обозначение (1) после названия проекта — это указание на номер итерации: «Первое ревью этого проекта». Новые итерации будут сверху, старые — ниже.
Поначалу будет непросто, но всё обязательно получится!